The following document describes the different environmental
variables that you can set with the 'set_env' command.

%^BOLD%^Index:%^RESET%^

All:

 1. auto_tune
 2. colour
 3. prompt
 4. page_display
 
Developers only:
 
 5. start_location
 6. news_client
 7. morelines
 8. biff
 9. debug_output
10. custom_clone, custom_dest
11. move_in, move_out
12. teleport_in, teleport_out

%^BOLD%^Variable%^RESET%^    : auto_tune
%^MAGENTA%^Arguments%^RESET%^   : Channels/Modules names
%^BOLD%^%^BLUE%^Example%^RESET%^     : lpuni localNet announceNet
%^GREEN%^Description%^RESET%^ :

This variable allows you to specify which channels
or channel modules/networks you wish to automatically
tune into when you login. If you wish to tune into multiple
channels or modules, seperate the names by spaces.

%^YELLOW%^Note:%^RESET%^ Case does matter.

%^BOLD%^Variable%^RESET%^    : colour
%^MAGENTA%^Arguments%^RESET%^   : enabled || disabled
%^BOLD%^%^BLUE%^Example%^RESET%^     : enabled
%^GREEN%^Description%^RESET%^ :

This variable allows you to toggle the rendering of colour.
If not set to 'enabled' then colour will not render (ie. disabled
is a pseudo argument.

%^YELLOW%^Note:%^RESET%^ You may also use the "colour" command to
toggle this environmental variable.

%^BOLD%^Variable%^RESET%^    : prompt
%^MAGENTA%^Arguments%^RESET%^   : <tokens>
%^BOLD%^%^BLUE%^Example%^RESET%^     : %t >
%^GREEN%^Description%^RESET%^ :

        This variable allows you to construct a custom prompt using
        different tokens and text. The following tokens can be used by
        everyone:
    
        %n -> Your name, %m -> Mud's name, %t -> Current time
        $n-> Line break/new line
    
        Developers may also use the following tokens:
    
        %d -> CWD, %f -> CWF, %u -> Current # of users logged in
        %l -> Filename of current environment
    
        %^YELLOW%^Note:%^RESET%^ Please let us know if you have anymore
                ideas for tokens.

%^BOLD%^Variable%^RESET%^    : page_display
%^MAGENTA%^Arguments%^RESET%^   : percent | lines
%^BOLD%^%^BLUE%^Example%^RESET%^     : percent
%^GREEN%^Description%^RESET%^ :

        This variable allows you to change whether you see the percentage
        of a document viewed or the line numbers of the current page of
        a document.

%^BOLD%^Variable%^RESET%^    : start_location
%^MAGENTA%^Arguments%^RESET%^   : Full path to room or 'last_location'
%^BOLD%^%^BLUE%^Example%^RESET%^     : /areas/lpuni/entrance.c
%^GREEN%^Description%^RESET%^ :

This variable allows you to set a start_location besides the
standard one if you are a developer (ie. If you are not a developer
then setting this environmental variable will have no effect).
You may provide a full path to a room or set it to last_location
to return to the last room you were in before logging out.

If developers do not set a start_location, they will default to
their workroom.c in their home directory (if it exists - if not
then the same as players). Players start in /areas/lpuni/entrance.c

%^BOLD%^Variable%^RESET%^    : morelines
%^MAGENTA%^Arguments%^RESET%^   : number of lines
%^BOLD%^%^BLUE%^Example%^RESET%^     : 40
%^GREEN%^Description%^RESET%^ :

This variable will set how many lines appear per cycle whenever
text needs to be paged.

%^BOLD%^Variable%^RESET%^    : biff
%^MAGENTA%^Arguments%^RESET%^   : on | off
%^BOLD%^%^BLUE%^Example%^RESET%^     : on
%^GREEN%^Description%^RESET%^ :

This variable will set whether or not you recieve the new mail
notification when you log in, or when someone sends you a piece
of mail.

%^BOLD%^Variable%^RESET%^    : debug_output
%^MAGENTA%^Arguments%^RESET%^   : enabled || disabled
%^BOLD%^%^BLUE%^Example%^RESET%^     : disabled
%^GREEN%^Description%^RESET%^ :

This variable allows you to disable the output of compile
time errors. If set to 'disabled' then compile time errors
will not be printed to your terminal (such as when you use
the 'update' command; ie. 'enabled' is a pseudo argument).
The compile time errors however will be written to the log
files as usual.

%^RED%^Warning:%^RESET%^ When you use eval, you'll notice that it won't
print anything if there are any compile-time errors
if you have this enabled.

%^BOLD%^Variable%^RESET%^    : custom_clone/custom_dest
%^MAGENTA%^Arguments%^RESET%^   : <message to be printed>
%^BOLD%^%^BLUE%^Example%^RESET%^     : $Npiledrives 
%^GREEN%^Description%^RESET%^ :

This variable allows a developer to provide custom messages
to be printed whenever he/she clones/destroys an object.
$Nwill be replaced with the users name, and $Owill be replaced
with the name of the object.

%^BOLD%^Variable%^RESET%^    : move_in, move_out
%^MAGENTA%^Arguments%^RESET%^   : <message to be printed>
%^BOLD%^%^BLUE%^Example%^RESET%^     : $Nmoves catlike 
%^GREEN%^Description :%^RESET%^

These variables allow a developer to provide custom messages for
whenever he/she moves normally to a room. The move_in message will
be printed to the room the user moves into, and the move_out
message will be printed to the room the user moves from. $Nwill
be replaced with the users name, and $Dwill be replaced with the
direction/exit they use. 

%^YELLOW%^Note:%^RESET%^ You are not required to use either $Nor
$D you may put your name in literally if you wish.

%^BOLD%^Variable%^RESET%^    : teleport_in, teleport_out
%^MAGENTA%^Arguments%^RESET%^   : <message to be printed>
%^BOLD%^%^BLUE%^Example%^RESET%^     : $Nflys away to the 
%^GREEN%^Description :%^RESET%^

These variables allow a developer to provide custom messages for
whenever he/she teleports to a different place. The teleport_in
messages is printed to the room the user teleports to, while the
teleport_out message is printed to the room the user teleports
from. $Nin the message will be replaced with the user's name, and
$Dwill be replaced with the location being teleported to.

%^YELLOW%^Note:%^RESET%^ You are not required to use either $Nor
$D you may put your name in literally if you wish.

 %^BOLD%^See also:%^RESET%^ set_env

